Vapi Std LocalizationParam

Vapi Std LocalizationParam

This schema holds a single message parameter and formatting settings for it. The schema has fields for string, long, double, date time and nested messages. Only one will be used depending on the type of data sent. For date, double and long it is possible to set additional formatting details.

This schema was added in vSphere API 7.0.0.0.

JSON Example

{
    "s": "string",
    "dt": "string",
    "i": 0,
    "d": "number",
    "l": "Vapi Std NestedLocalizableMessage Object",
    "format": "string",
    "precision": 0
}

string

s

Optional

String value associated with the parameter.

This property was added in vSphere API 7.0.0.0.

this property will be set when string value is used.

string As date-time As date-time

dt

Optional

Date and time value associated with the parameter. Use the format property to specify date and time display style.

This property was added in vSphere API 7.0.0.0.

this property will be set when date and time value is used.

integer As int64 As int64

i

Optional

long value associated with the parameter.

This property was added in vSphere API 7.0.0.0.

this property will be set when long value is used.

number As double As double

d

Optional

The double value associated with the parameter. The number of displayed fractional digits is changed via precision property.

This property was added in vSphere API 7.0.0.0.

this property will be set when double value is used.

l

Optional

Nested localizable value associated with the parameter. This is useful construct to convert to human readable localized form enumerated type and boolean values. It can also be used for proper handling of pluralization and gender forms in localization. Recursive Vapi Std NestedLocalizableMessage instances can be used for localizing short lists of items.

This property was added in vSphere API 7.0.0.0.

this property will be set when nested localization message value is used.

string

format

Optional

Format associated with the date and time value in dt property. The enumeration value SHORT_DATETIME will be used as default.

For more information see: Vapi Std LocalizationParam DateTimeFormat.

This property was added in vSphere API 7.0.0.0.

this may not be set if enumeration value SHORT_DATETIME default format is appropriate

integer As int64 As int64

precision

Optional

Number of fractional digits to include in formatted double value.

This property was added in vSphere API 7.0.0.0.

this will be set when exact precision is required for rendering double numbers.